Decision module
Decision
Bases: Module
Perform a decision on the given input based on a question and a list of labels.
This module dynamically create an Enum schema based on the given labels and
use it to generate a possible answer using structured output.
This ensure that the LM answer is always one of the provided labels.
Example:
import synalinks
import asyncio
async def main():
language_model = synalinks.LanguageModel(
model="ollama/mistral",
)
x0 = synalinks.Input(data_model=synalinks.ChatMessages)
x1 = await synalinks.Decision(
question="What is the danger level of the discussion?",
labels=["low", "medium", "high"],
language_model=language_model,
)(x0)
program = synalinks.Program(
inputs=x0,
outputs=x1,
name="discussion_danger_assessment",
description="This program assesses the level of danger in a discussion.",
)
if __name__ == "__main__":
asyncio.run(main())
Pass a decision_model to decide with a DecisionModel instead of the
language model: faster and cheaper, with calibrated answers, but without
step by step reasoning. The question is asked to the decision model as
is, and the output has no thinking field, only the choice. With
min_confidence, a decision the decision model is not sure enough about
is not taken: the module returns None, so a Branch selects no branch.
x1 = await synalinks.Decision(
question="What is the danger level of the discussion?",
labels=["low", "medium", "high"],
decision_model=synalinks.DecisionModel(model="typesafe/jev-latest"),
)(x0)
You can view this module, as performing a single label classification on the input.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
question
|
str
|
The question to ask. |
None
|
labels
|
list
|
The list of labels to choose from (strings). |
None
|
language_model
|
LanguageModel
|
The language model to use. |
None
|
prompt_template
|
str
|
The default jinja2 prompt template
to use (see |
None
|
examples
|
list
|
The default examples to use in the prompt
(see |
None
|
instructions
|
list
|
The default instructions to use (see |
None
|
seed_instructions
|
list
|
Optional. A list of instructions to use as seed for the optimization. If not provided, use the default instructions as seed. |
None
|
temperature
|
float
|
Optional. The temperature for the LM call. |
None
|
max_tokens
|
int
|
Optional. Default None (model's own default). Caps the generation length. |
None
|
top_p
|
float
|
Optional. Default None (model's own default). Nucleus sampling probability. |
None
|
top_k
|
int
|
Optional. Default None (model's own default). Top-k sampling cutoff. |
None
|
reasoning_effort
|
string
|
Optional. The reasoning effort for the LM call between ['minimal', 'low', 'medium', 'high', 'disable', 'none', None]. Default to None (no reasoning). |
None
|
use_inputs_schema
|
bool
|
Optional. Whether or not use the inputs schema in
the prompt (Default to False) (see |
False
|
use_outputs_schema
|
bool
|
Optional. Whether or not use the outputs schema in
the prompt (Default to False) (see |
False
|
name
|
str
|
Optional. The name of the module. |
None
|
description
|
str
|
Optional. The description of the module. |
None
|
trainable
|
bool
|
Whether the module's variables should be trainable. |
True
|
decision_model
|
DecisionModel
|
Optional. A decision model to decide
with instead of the language model: the question is asked as is,
over the labels, and the output has no |
None
|
min_confidence
|
float
|
Optional. With a decision model, the confidence
(from 0 to 1) under which no decision is taken: the module then
returns |
None
|
Source code in synalinks/src/modules/core/decision.py
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 | |
decision_model_question_schema(question, labels)
Return the schema the DecisionModel answers for a Decision: the
question, asked as is, as a choice over the labels.
Source code in synalinks/src/modules/core/decision.py
decision_model_schema(labels)
Return the Decision output schema when a DecisionModel decides.
Decision models answer typed questions without reasoning step by step, so
there is no thinking field: the output is only the choice.
Source code in synalinks/src/modules/core/decision.py
default_decision_instructions(labels)
The decision default instructions